/*
 * TMap Designer - A Thematic Map design software
 * Copyright (C) 2006 World Health Organization
 * http://www.who.int
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
package who.tmap.bo.cd;

import java.awt.Color;

/**
 * This interface represents a Color/Pattern range
 * It extends CartographicDisplay for convenience only (use of the factory)
 * @see CDColorPattern
 * @author stl
 *
 */
public interface ColorPatternRange extends CartographicDisplay {
	
    public static final Color[] DEFAULT_RANGE_COLORS ={ Color.YELLOW, Color.RED, Color.GREEN, Color.ORANGE, 
		Color.MAGENTA, Color.BLUE, Color.PINK, Color.GRAY, 
		Color.DARK_GRAY, Color.CYAN,
		Color.LIGHT_GRAY, Color.WHITE, Color.BLACK };    
	
	void setRangeIdx( int rangeIdx );
	int getRangeIdx();
	
	void setFrom( double from );
	double getFrom();
	
	void setTo( double to );
	double getTo();
	
	void setColor( Color color );
	Color getColor();
	
	void setFillPattern( int fillPattern );
	int getFillPattern();
	
	void setCaption( String caption );
	String getCaption();
	
}
